<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>i2stx: xi2stx.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">i2stx
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xi2stx_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xi2stx.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_i2stx___config.html">XI2stx_Config</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains configuration information for the I2s Transmitter.  <a href="struct_x_i2stx___config.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_i2s___tx.html">XI2s_Tx</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef implements the I2s Transmitter driver instance data.  <a href="struct_x_i2s___tx.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a9212fbef371b7c3d7eff45b842a3aaa9"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xi2stx_8h.html#a9212fbef371b7c3d7eff45b842a3aaa9">XI2s_Tx_Callback</a> )(void *CallbackRef)</td></tr>
<tr class="memdesc:a9212fbef371b7c3d7eff45b842a3aaa9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback function data type for handling interrupt requests from the I2s Transmitter peripheral.  <a href="#a9212fbef371b7c3d7eff45b842a3aaa9">More...</a><br/></td></tr>
<tr class="separator:a9212fbef371b7c3d7eff45b842a3aaa9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga5aae612901765b9ea6bb107e5b66b619"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2stx.html#ga5aae612901765b9ea6bb107e5b66b619">XI2s_Tx_ChannelId</a> { <br/>
&#160;&#160;<a class="el" href="group__i2stx.html#gga5aae612901765b9ea6bb107e5b66b619a68360ea065dc9915804147319571fc59">XI2S_TX_CHID0</a> = 0, 
<a class="el" href="group__i2stx.html#gga5aae612901765b9ea6bb107e5b66b619aed6153a58db47e421c6b9e4503139f5b">XI2S_TX_CHID1</a>, 
<a class="el" href="group__i2stx.html#gga5aae612901765b9ea6bb107e5b66b619aabd0ee55dfa4069baa47050377781227">XI2S_TX_CHID2</a>, 
<a class="el" href="group__i2stx.html#gga5aae612901765b9ea6bb107e5b66b619af2f3fde5b16d7a77d36e18bc3f57d739">XI2S_TX_CHID3</a>, 
<br/>
&#160;&#160;<a class="el" href="group__i2stx.html#gga5aae612901765b9ea6bb107e5b66b619a252275e8db08efabd78dbe0c652605f4">XI2S_TX_NUM_CHANNELS</a>
<br/>
 }</td></tr>
<tr class="memdesc:ga5aae612901765b9ea6bb107e5b66b619"><td class="mdescLeft">&#160;</td><td class="mdescRight">These constants specify different channel ID's.  <a href="group__i2stx.html#ga5aae612901765b9ea6bb107e5b66b619">More...</a><br/></td></tr>
<tr class="separator:ga5aae612901765b9ea6bb107e5b66b619"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2530845dc4c6c409a2cb7025beda590f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xi2stx_8h.html#a2530845dc4c6c409a2cb7025beda590f">XI2s_Tx_Justification</a> { <a class="el" href="xi2stx_8h.html#a2530845dc4c6c409a2cb7025beda590fabdb67d3f765c6f594cab030416ec0582">XI2S_TX_JUSTIFY_LEFT</a> = 0, 
<a class="el" href="xi2stx_8h.html#a2530845dc4c6c409a2cb7025beda590fac30016a424a039d624fece3591ee9f6a">XI2S_TX_JUSTIFY_RIGHT</a>
 }</td></tr>
<tr class="memdesc:a2530845dc4c6c409a2cb7025beda590f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef specifies the justification of the the XI2s Transmitter.  <a href="xi2stx_8h.html#a2530845dc4c6c409a2cb7025beda590f">More...</a><br/></td></tr>
<tr class="separator:a2530845dc4c6c409a2cb7025beda590f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">XI2S_Tx_Handlertype</div></td></tr>
<tr class="memitem:ga826ab5acb6a522281f46f358fc908bf3"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2stx.html#ga826ab5acb6a522281f46f358fc908bf3">XI2s_Tx_HandlerType</a> { <br/>
&#160;&#160;<a class="el" href="group__i2stx.html#gga826ab5acb6a522281f46f358fc908bf3aee14491aed8a040a938a4a67e74bc6bd">XI2S_TX_HANDLER_AES_BLKCMPLT</a> = 0, 
<a class="el" href="group__i2stx.html#gga826ab5acb6a522281f46f358fc908bf3a8172cb6e2a0d147df0f06a0eada66f8d">XI2S_TX_HANDLER_AES_BLKSYNCERR</a>, 
<a class="el" href="group__i2stx.html#gga826ab5acb6a522281f46f358fc908bf3ab9374d0904c4cd4ac730b17fff220107">XI2S_TX_HANDLER_AES_CHSTSUPD</a>, 
<a class="el" href="group__i2stx.html#gga826ab5acb6a522281f46f358fc908bf3a346f30997b8d6d69e215f08a6db8d4ac">XI2S_TX_HANDLER_AUD_UNDRFLW</a>, 
<br/>
&#160;&#160;<a class="el" href="group__i2stx.html#gga826ab5acb6a522281f46f358fc908bf3a9dfc593232c7f0a4b318f14bd1680e6d">XI2S_TX_NUM_HANDLERS</a>
<br/>
 }</td></tr>
<tr class="memdesc:ga826ab5acb6a522281f46f358fc908bf3"><td class="mdescLeft">&#160;</td><td class="mdescRight">these constants specify different types of handlers and is used to differentiate interrupt requests from the I2s Transmitter peripheral.  <a href="group__i2stx.html#ga826ab5acb6a522281f46f358fc908bf3">More...</a><br/></td></tr>
<tr class="separator:ga826ab5acb6a522281f46f358fc908bf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">XI2s_Tx_ChMuxInput</div></td></tr>
<tr class="memitem:a986ff4cc8196e017c2a11b5784cfa410"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xi2stx_8h.html#a986ff4cc8196e017c2a11b5784cfa410">XI2s_Tx_ChMuxInput</a> { <br/>
&#160;&#160;<a class="el" href="xi2stx_8h.html#a986ff4cc8196e017c2a11b5784cfa410aedc2b482cf243d4fce159e5d37a18f89">XI2S_TX_CHMUX_DISABLED</a> = 0, 
<a class="el" href="xi2stx_8h.html#a986ff4cc8196e017c2a11b5784cfa410a6f972c1a8f40e982c18bd08a568bb566">XI2S_TX_CHMUX_AXIS_01</a>, 
<a class="el" href="xi2stx_8h.html#a986ff4cc8196e017c2a11b5784cfa410a64201d5cdf20350b03a6e6e93da13173">XI2S_TX_CHMUX_AXIS_23</a>, 
<a class="el" href="xi2stx_8h.html#a986ff4cc8196e017c2a11b5784cfa410affaf08c53c7afa2b8d788dced78a32bc">XI2S_TX_CHMUX_AXIS_45</a>, 
<br/>
&#160;&#160;<a class="el" href="xi2stx_8h.html#a986ff4cc8196e017c2a11b5784cfa410a84dfb423929256e872592e9c921fd099">XI2S_TX_CHMUX_AXIS_67</a>, 
<a class="el" href="xi2stx_8h.html#a986ff4cc8196e017c2a11b5784cfa410ae563eb5c2611dddc3b40f94aa619b991">XI2S_TX_CHMUX_WAVEGEN</a>
<br/>
 }</td></tr>
<tr class="memdesc:a986ff4cc8196e017c2a11b5784cfa410"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef specifies the input sources of the the I2s Transmitter.  <a href="xi2stx_8h.html#a986ff4cc8196e017c2a11b5784cfa410">More...</a><br/></td></tr>
<tr class="separator:a986ff4cc8196e017c2a11b5784cfa410"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga4efbba75f40c33ec9a37a033c2592bd8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2stx.html#ga4efbba75f40c33ec9a37a033c2592bd8">XI2s_Tx_SelfTest</a> (<a class="el" href="struct_x_i2s___tx.html">XI2s_Tx</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga4efbba75f40c33ec9a37a033c2592bd8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Runs a self-test on the driver/device.  <a href="group__i2stx.html#ga4efbba75f40c33ec9a37a033c2592bd8">More...</a><br/></td></tr>
<tr class="separator:ga4efbba75f40c33ec9a37a033c2592bd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0bbbcbd065d1e0348187ba03cb3b67fb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_i2stx___config.html">XI2stx_Config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2stx.html#ga0bbbcbd065d1e0348187ba03cb3b67fb">XI2s_Tx_LookupConfig</a> (u16 DeviceId)</td></tr>
<tr class="memdesc:ga0bbbcbd065d1e0348187ba03cb3b67fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns a reference to an <a class="el" href="struct_x_i2stx___config.html" title="This typedef contains configuration information for the I2s Transmitter. ">XI2stx_Config</a> structure based on the core id, <em>DeviceId</em>.  <a href="group__i2stx.html#ga0bbbcbd065d1e0348187ba03cb3b67fb">More...</a><br/></td></tr>
<tr class="separator:ga0bbbcbd065d1e0348187ba03cb3b67fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab33cb9b421dbb85cef8a75a0dbf8a1dd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2stx.html#gab33cb9b421dbb85cef8a75a0dbf8a1dd">XI2s_Tx_CfgInitialize</a> (<a class="el" href="struct_x_i2s___tx.html">XI2s_Tx</a> *InstancePtr, <a class="el" href="struct_x_i2stx___config.html">XI2stx_Config</a> *CfgPtr, UINTPTR EffectiveAddr)</td></tr>
<tr class="memdesc:gab33cb9b421dbb85cef8a75a0dbf8a1dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes the I2S Transmitter.  <a href="group__i2stx.html#gab33cb9b421dbb85cef8a75a0dbf8a1dd">More...</a><br/></td></tr>
<tr class="separator:gab33cb9b421dbb85cef8a75a0dbf8a1dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac4321c85028de0ddb48f966d80325b10"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2stx.html#gac4321c85028de0ddb48f966d80325b10">XI2s_Tx_Enable</a> (<a class="el" href="struct_x_i2s___tx.html">XI2s_Tx</a> *InstancePtr, u8 Enable)</td></tr>
<tr class="memdesc:gac4321c85028de0ddb48f966d80325b10"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function enables/disables the I2s Transmitter.  <a href="group__i2stx.html#gac4321c85028de0ddb48f966d80325b10">More...</a><br/></td></tr>
<tr class="separator:gac4321c85028de0ddb48f966d80325b10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga265a3458a6fd3232bba3df9f9341e3cd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2stx.html#ga265a3458a6fd3232bba3df9f9341e3cd">XI2s_Tx_SetChMux</a> (<a class="el" href="struct_x_i2s___tx.html">XI2s_Tx</a> *InstancePtr, <a class="el" href="group__i2stx.html#ga5aae612901765b9ea6bb107e5b66b619">XI2s_Tx_ChannelId</a> ChID, <a class="el" href="xi2stx_8h.html#a986ff4cc8196e017c2a11b5784cfa410">XI2s_Tx_ChMuxInput</a> InputSource)</td></tr>
<tr class="memdesc:ga265a3458a6fd3232bba3df9f9341e3cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the input source for the specified I2s channel.  <a href="group__i2stx.html#ga265a3458a6fd3232bba3df9f9341e3cd">More...</a><br/></td></tr>
<tr class="separator:ga265a3458a6fd3232bba3df9f9341e3cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacdd2c6678f1038ca76099cbcaebe1fde"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2stx.html#gacdd2c6678f1038ca76099cbcaebe1fde">XI2s_Tx_SetSclkOutDiv</a> (<a class="el" href="struct_x_i2s___tx.html">XI2s_Tx</a> *InstancePtr, u32 MClk, u32 Fs)</td></tr>
<tr class="memdesc:gacdd2c6678f1038ca76099cbcaebe1fde"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function calculates the SCLK Output divider value of the I2S timing generator.  <a href="group__i2stx.html#gacdd2c6678f1038ca76099cbcaebe1fde">More...</a><br/></td></tr>
<tr class="separator:gacdd2c6678f1038ca76099cbcaebe1fde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8d2df1eb8affcff7f6b1eacad5016b39"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2stx.html#ga8d2df1eb8affcff7f6b1eacad5016b39">XI2s_Tx_IntrEnable</a> (<a class="el" href="struct_x_i2s___tx.html">XI2s_Tx</a> *InstancePtr, u32 Mask)</td></tr>
<tr class="memdesc:ga8d2df1eb8affcff7f6b1eacad5016b39"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function enables the specified interrupt of the I2s Transmitter.  <a href="group__i2stx.html#ga8d2df1eb8affcff7f6b1eacad5016b39">More...</a><br/></td></tr>
<tr class="separator:ga8d2df1eb8affcff7f6b1eacad5016b39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae5c7f651728493e9ca5a13d824f47893"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2stx.html#gae5c7f651728493e9ca5a13d824f47893">XI2s_Tx_JustifyEnable</a> (<a class="el" href="struct_x_i2s___tx.html">XI2s_Tx</a> *InstancePtr, u8 Enable)</td></tr>
<tr class="memdesc:gae5c7f651728493e9ca5a13d824f47893"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function enables/disables the justification.  <a href="group__i2stx.html#gae5c7f651728493e9ca5a13d824f47893">More...</a><br/></td></tr>
<tr class="separator:gae5c7f651728493e9ca5a13d824f47893"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab101d38c979a17b2bd4540a3b418933d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2stx.html#gab101d38c979a17b2bd4540a3b418933d">XI2s_Tx_Justify</a> (<a class="el" href="struct_x_i2s___tx.html">XI2s_Tx</a> *InstancePtr, <a class="el" href="xi2stx_8h.html#a2530845dc4c6c409a2cb7025beda590f">XI2s_Tx_Justification</a> Justify)</td></tr>
<tr class="memdesc:gab101d38c979a17b2bd4540a3b418933d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is to enable right/left justification.  <a href="group__i2stx.html#gab101d38c979a17b2bd4540a3b418933d">More...</a><br/></td></tr>
<tr class="separator:gab101d38c979a17b2bd4540a3b418933d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad17911935c47159f6b1c144c3df63ce2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2stx.html#gad17911935c47159f6b1c144c3df63ce2">XI2s_Tx_IntrHandler</a> (void *InstancePtr)</td></tr>
<tr class="memdesc:gad17911935c47159f6b1c144c3df63ce2"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is the interrupt handler for the I2S Transmitter driver.  <a href="group__i2stx.html#gad17911935c47159f6b1c144c3df63ce2">More...</a><br/></td></tr>
<tr class="separator:gad17911935c47159f6b1c144c3df63ce2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8ff9bb309a9e3902fbe95ce3bc48ac51"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2stx.html#ga8ff9bb309a9e3902fbe95ce3bc48ac51">XI2s_Tx_SetHandler</a> (<a class="el" href="struct_x_i2s___tx.html">XI2s_Tx</a> *InstancePtr, <a class="el" href="group__i2stx.html#ga826ab5acb6a522281f46f358fc908bf3">XI2s_Tx_HandlerType</a> HandlerType, <a class="el" href="xi2stx_8h.html#a9212fbef371b7c3d7eff45b842a3aaa9">XI2s_Tx_Callback</a> FuncPtr, void *CallbackRef)</td></tr>
<tr class="memdesc:ga8ff9bb309a9e3902fbe95ce3bc48ac51"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function installs an asynchronous callback function for the given HandlerType:  <a href="group__i2stx.html#ga8ff9bb309a9e3902fbe95ce3bc48ac51">More...</a><br/></td></tr>
<tr class="separator:ga8ff9bb309a9e3902fbe95ce3bc48ac51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab68c1f16ccac1a678e93bd9c3bcdaed0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2stx.html#gab68c1f16ccac1a678e93bd9c3bcdaed0">XI2s_Tx_GetAesChStatus</a> (<a class="el" href="struct_x_i2s___tx.html">XI2s_Tx</a> *InstancePtr, u8 *AesChStatusBuf)</td></tr>
<tr class="memdesc:gab68c1f16ccac1a678e93bd9c3bcdaed0"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function gets the captured AES Channel Status bits.  <a href="group__i2stx.html#gab68c1f16ccac1a678e93bd9c3bcdaed0">More...</a><br/></td></tr>
<tr class="separator:gab68c1f16ccac1a678e93bd9c3bcdaed0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae1ee6ead0b1745ef400ec3e5198068aa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2stx.html#gae1ee6ead0b1745ef400ec3e5198068aa">XI2s_Tx_ClrAesChStatRegs</a> (<a class="el" href="struct_x_i2s___tx.html">XI2s_Tx</a> *InstancePtr)</td></tr>
<tr class="memdesc:gae1ee6ead0b1745ef400ec3e5198068aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function clears the captured AES Channel Status bits.  <a href="group__i2stx.html#gae1ee6ead0b1745ef400ec3e5198068aa">More...</a><br/></td></tr>
<tr class="separator:gae1ee6ead0b1745ef400ec3e5198068aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6ecb01665e82e3373ad2de2085a8dc87"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2stx.html#ga6ecb01665e82e3373ad2de2085a8dc87">XI2s_Tx_LogDisplay</a> (<a class="el" href="struct_x_i2s___tx.html">XI2s_Tx</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga6ecb01665e82e3373ad2de2085a8dc87"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function prints the contents of the logging buffer.  <a href="group__i2stx.html#ga6ecb01665e82e3373ad2de2085a8dc87">More...</a><br/></td></tr>
<tr class="separator:ga6ecb01665e82e3373ad2de2085a8dc87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2a5815edce7bde17b937480d41849d02"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2stx.html#ga2a5815edce7bde17b937480d41849d02">XI2s_Tx_LogWrite</a> (<a class="el" href="struct_x_i2s___tx.html">XI2s_Tx</a> *InstancePtr, <a class="el" href="group__i2stx.html#ga6aae04d874f9b352d54806ffba47b000">XI2s_Tx_LogEvt</a> Event, u8 Data)</td></tr>
<tr class="memdesc:ga2a5815edce7bde17b937480d41849d02"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function writes I2S Transmitter logs into the buffer.  <a href="group__i2stx.html#ga2a5815edce7bde17b937480d41849d02">More...</a><br/></td></tr>
<tr class="separator:ga2a5815edce7bde17b937480d41849d02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga18ca2b281e98177be7e6062051cb352f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_i2s___tx___log_item.html">XI2s_Tx_LogItem</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2stx.html#ga18ca2b281e98177be7e6062051cb352f">XI2s_Tx_LogRead</a> (<a class="el" href="struct_x_i2s___tx.html">XI2s_Tx</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga18ca2b281e98177be7e6062051cb352f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the next item in the logging buffer.  <a href="group__i2stx.html#ga18ca2b281e98177be7e6062051cb352f">More...</a><br/></td></tr>
<tr class="separator:ga18ca2b281e98177be7e6062051cb352f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaa1a03db44d1813c7632b95ec83765d5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2stx.html#gaaa1a03db44d1813c7632b95ec83765d5">XI2s_Tx_LogReset</a> (<a class="el" href="struct_x_i2s___tx.html">XI2s_Tx</a> *InstancePtr)</td></tr>
<tr class="memdesc:gaaa1a03db44d1813c7632b95ec83765d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function clears the contents of the logging buffer.  <a href="group__i2stx.html#gaaa1a03db44d1813c7632b95ec83765d5">More...</a><br/></td></tr>
<tr class="separator:gaaa1a03db44d1813c7632b95ec83765d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a9212fbef371b7c3d7eff45b842a3aaa9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* XI2s_Tx_Callback)(void *CallbackRef)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Callback function data type for handling interrupt requests from the I2s Transmitter peripheral. </p>
<p>The application using this driver is expected to define a handler of this type to support interrupt driven mode. The handler is called in an interrupt context such that minimal processing should be performed.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">CallBackRef</td><td>is a callback reference passed in by the upper layer when setting the callback functions, and passed back to the upper layer when the callback is invoked.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="a986ff4cc8196e017c2a11b5784cfa410"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xi2stx_8h.html#a986ff4cc8196e017c2a11b5784cfa410">XI2s_Tx_ChMuxInput</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This typedef specifies the input sources of the the I2s Transmitter. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a986ff4cc8196e017c2a11b5784cfa410aedc2b482cf243d4fce159e5d37a18f89"></a>XI2S_TX_CHMUX_DISABLED</em>&nbsp;</td><td class="fielddoc">
<p>Channel disabled. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a986ff4cc8196e017c2a11b5784cfa410a6f972c1a8f40e982c18bd08a568bb566"></a>XI2S_TX_CHMUX_AXIS_01</em>&nbsp;</td><td class="fielddoc">
<p>AXI-Stream Audio Channel 0 and 1. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a986ff4cc8196e017c2a11b5784cfa410a64201d5cdf20350b03a6e6e93da13173"></a>XI2S_TX_CHMUX_AXIS_23</em>&nbsp;</td><td class="fielddoc">
<p>AXI-Stream Audio Channel 2 and 3. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a986ff4cc8196e017c2a11b5784cfa410affaf08c53c7afa2b8d788dced78a32bc"></a>XI2S_TX_CHMUX_AXIS_45</em>&nbsp;</td><td class="fielddoc">
<p>AXI-Stream Audio Channel 4 and 5. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a986ff4cc8196e017c2a11b5784cfa410a84dfb423929256e872592e9c921fd099"></a>XI2S_TX_CHMUX_AXIS_67</em>&nbsp;</td><td class="fielddoc">
<p>AXI-Stream Audio Channel 6 and 7. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a986ff4cc8196e017c2a11b5784cfa410ae563eb5c2611dddc3b40f94aa619b991"></a>XI2S_TX_CHMUX_WAVEGEN</em>&nbsp;</td><td class="fielddoc">
<p>Wave Generator. </p>
</td></tr>
</table>

</div>
</div>
<a class="anchor" id="a2530845dc4c6c409a2cb7025beda590f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xi2stx_8h.html#a2530845dc4c6c409a2cb7025beda590f">XI2s_Tx_Justification</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This typedef specifies the justification of the the XI2s Transmitter. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a2530845dc4c6c409a2cb7025beda590fabdb67d3f765c6f594cab030416ec0582"></a>XI2S_TX_JUSTIFY_LEFT</em>&nbsp;</td><td class="fielddoc">
<p>Left Justification is enabled. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a2530845dc4c6c409a2cb7025beda590fac30016a424a039d624fece3591ee9f6a"></a>XI2S_TX_JUSTIFY_RIGHT</em>&nbsp;</td><td class="fielddoc">
<p>Right Justification is enabled. </p>
</td></tr>
</table>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
